# 函数的说明文档: 可以在提示信息中展示出来的说明文字
# 提示信息出现的方式鼠标悬停在函数调用位置上,或者按住ctrl键鼠标悬停
# 格式: 在函数体的第一行书写多行注释,则为说明文档

# 如果我们使用普通注释,不能在鼠标悬停后进行提示
def func1():
    # 打印了一首诗
    print('莫等闲,白了少年头,空悲切.')


func1()

print('----------------------------------')


# 在函数的函数体第一行书写一个多行注释,则可以进行说明文档提示
def func2():
    """打印了一首诗"""
    print('莫等闲,白了少年头,空悲切.')


func2()


print('----------------------------------')


# 在函数提的第一行,使用多行注释时,尽量使用双引号,单引号一样可以作为说明文档进行提示,但是会报一行格式异常(灰色波浪线)
def func3():
    '''打印一首诗'''
    print('莫等闲,白了少年头,空悲切.')


func3()

"""
灰色波浪线: 格式警告
绿色波浪线: 拼写错误
红色波浪线: 语法错误
"""

